Skip to content

Apply ContinuousCompliance PR#26: word list policy guardrails for .cspell.yaml#45

Merged
Malcolmnixon merged 4 commits intomainfrom
copilot/apply-continuous-compliance-pr-26
Mar 19, 2026
Merged

Apply ContinuousCompliance PR#26: word list policy guardrails for .cspell.yaml#45
Malcolmnixon merged 4 commits intomainfrom
copilot/apply-continuous-compliance-pr-26

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Mar 19, 2026

Pull Request

Description

Agents have been bypassing spell-checking by adding misspelled words to .cspell.yaml. This applies demaconsulting/ContinuousCompliance#26 to add explicit policy guardrails.

  • .cspell.yaml: Adds three policy lines to the PURPOSE block — misspelled words must be fixed at source, never added to the word list; genuine technical terms require a reviewed proposal before being added. Removes the misleading (update as needed) hint.
  • AGENTS.md: Adds a Spell check word list policy subsection under Key Files. Spells out the fix-vs-propose distinction explicitly for agent consumers, with the proposal wording set to "(e.g. comment in a pull request)".
  • CONTRIBUTING.md: Replaces the misleading "Add project-specific terms to .cspell.yaml" guidance in the Spell Checking section with the same fix-vs-propose policy, ensuring consistency for human contributors.

Type of Change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update
  • Code quality improvement

Related Issues

Pre-Submission Checklist

Before submitting this pull request, ensure you have completed the following:

Build and Test

  • Code builds successfully: dotnet build --configuration Release
  • All unit tests pass: dotnet test --configuration Release
  • Code produces zero warnings

Code Quality

  • Code formatting is correct: dotnet format --verify-no-changes
  • New code has appropriate XML documentation comments
  • Static analyzer warnings have been addressed

Quality Checks

Please run the following checks before submitting:

  • Spell checker passes: cspell "**/*.{md,cs}"
  • Markdown linter passes: markdownlint "**/*.md"
  • YAML linter passes: yamllint .

Testing

  • Added unit tests for new functionality
  • Updated existing tests if behavior changed
  • All tests follow the AAA (Arrange, Act, Assert) pattern
  • Test coverage is maintained or improved

Documentation

  • Updated README.md (if applicable)
  • Updated ARCHITECTURE.md (if applicable)
  • Added code examples for new features (if applicable)
  • Updated requirements.yaml (if applicable)

Additional Notes

Upstream reference: demaconsulting/ContinuousCompliance#26


📍 Connect Copilot coding agent with Jira, Azure Boards or Linear to delegate work to Copilot in one click without leaving your project management tool.

….cspell.yaml and AGENTS.md

Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>
Copilot AI changed the title [WIP] Apply changes from ContinuousCompliance PR #26 Apply ContinuousCompliance PR#26: word list policy guardrails for .cspell.yaml Mar 19, 2026
Copilot AI requested a review from Malcolmnixon March 19, 2026 17:03
@Malcolmnixon Malcolmnixon marked this pull request as ready for review March 19, 2026 17:12
Copilot AI review requested due to automatic review settings March 19, 2026 17:12
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Applies explicit guardrails to prevent bypassing spell-checking by adding misspellings to the cspell word list, aligning this repo with ContinuousCompliance PR#26.

Changes:

  • Adds a “Spell check word list policy” section to AGENTS.md describing fix-vs-propose behavior for cspell findings.
  • Updates .cspell.yaml PURPOSE block to explicitly forbid adding misspellings and to require proposals for genuine technical terms.
  • Removes the misleading “(update as needed)” hint from the .cspell.yaml word list comment.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.

File Description
AGENTS.md Documents the repository policy for handling cspell failures (fix misspellings; propose additions for legitimate terms).
.cspell.yaml Strengthens the PURPOSE guidance and removes wording that could encourage unreviewed word-list expansion.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

You can also share your feedback on Copilot code review. Take the survey.

Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>
Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>
@Malcolmnixon Malcolmnixon merged commit fac1931 into main Mar 19, 2026
6 checks passed
@Malcolmnixon Malcolmnixon deleted the copilot/apply-continuous-compliance-pr-26 branch March 19, 2026 17:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants